home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d12 / ecstr3.arc / READ.ME < prev    next >
Text File  |  1987-03-04  |  8KB  |  132 lines
  1. File   : READ-ME
  2. Author : Richard A. O'Keefe.
  3. Updated: 1 June 1984.
  4. Purpose: Explain the new strings package.
  5.  
  6.     The UNIX string libraries (described in the string(3) manual page)
  7. differ from UNIX to UNIX (e.g. strtok is not in V7 or 4.1bsd).  Worse,
  8. the sources are not in the public domain, so that if there is a string
  9. routine which is nearly what you want but not quite you can't  take  a
  10. copy  and  modify it.  And of course C programmers on non-UNIX systems
  11. are at the mercy of their supplier.
  12.  
  13.     This package was designed to let me do reasonable things with  C's
  14. strings  whatever UNIX (V7, PaNiX, UX63, 4.1bsd) I happen to be using.
  15. Everything in the System III manual is here and does just what the  S3
  16. manual  says  it does.  There are also lots of new goodies.  I'm sorry
  17. about the names, but the routines do have to work  on  asphyxiated-at-
  18. birth  systems  which  truncate identifiers.  The convention is that a
  19. routine is called
  20.        str [n] [c] <operation>
  21. If there is an "n", it means that the function takes an (int) "length"
  22. argument, which bounds the number of characters to be moved or  looked
  23. at.  If the function has a "set" argument, a "c" in the name indicates
  24. that  the complement of the set is used.  Functions or variables whose
  25. names start with _ are support routines which aren't really meant  for
  26. general  use.  I don't know what the "p" is doing in "strpbrk", but it
  27. is there in the S3 manual so it's here too.  "istrtok" does not follow
  28. this rule, but with 7 letters what can you do?
  29.  
  30.     I have included new versions of atoi(3) and atol(3) as well.  They
  31. use a new primitive str2int, which takes a pair of bounds and a radix,
  32. and does much more thorough checking than the normal atoi and atol do.
  33. The result returned by atoi & atol is valid if and only if errno == 0.
  34. There is also an output conversion routine int2str, with itoa and ltoa
  35. as interface macros.  Only after writing int2str did I notice that the
  36. str2int routine has no provision for unsigned numbers.  On reflection,
  37. I don't greatly care.   I'm afraid that int2str may depend on your "C"
  38. compiler in unexpected ways.  Do check the code with -S.
  39.  
  40.     Several of these routines have "asm" inclusions conditional on the
  41. VaxAsm option.  These insertions can make the routines which have them
  42. quite a bit faster, but there is a snag.  The VAX architects, for some
  43. reason best known to themselves and their therapists, decided that all
  44. "strings" were shorter than 2^16 bytes.  Even when the length operands
  45. are in 32-bit registers, only 16 bits count.  So the "asm" versions do
  46. not work for long strings.  If you can guarantee that all your strings
  47. will be short, define VaxAsm in the makefile, but in general, and when
  48. using other machines, do not define it.
  49.  
  50.     Thanks to someone on the net who saw the first posting of strings,
  51. and sent me a formatted copy of the System V memory(3C) manual page, I
  52. have been able to include versions of these routines.   The convention
  53. is that they are called
  54.        mem{operation}([dst,] ... , len)
  55. where operation is cpy, cmp, chr, and so on, and len is how many bytes
  56. to move or test.  Note that this is different from the strn functions,
  57.        str{operation}  -- stop when you find a NUL character
  58.        strn{operation} -- stop when len is exhausted or you find NUL
  59.        mem{operation}  -- stop when len is exhausted
  60.        b{operation}    -- stop when len is exhausted
  61. but the b family has different argument orders or different results or
  62. both.  In particular, note that my implementation of bcmp does conform
  63. to the letter of the 4.2bsd manual page, but I decided to make it give
  64. a value I have often wanted, which is not like the value of strcmp. As
  65. the System V manual page is more explicit about the return code memcmp
  66. DOES return a value like strcmp, so you may prefer to use it.  BEWARE:
  67. the "c" in the name mem-c-cpy doesn't mean what it does in the System3
  68. names, it's more like mem-chr-cpy.
  69.  
  70.     To use this library, you need the "strings.a" library file and the
  71. "strings.h" header file.  The other header files are for compiling the
  72. library itself, though if you are hacking extensions you may find them
  73. useful.  General users really shouldn't see them.  I've defined a  few
  74. macros  I find useful in "strings.h"; if you have no need for "index",
  75. "rindex", "streql", and "beql", just edit them  out.   On  the  4.1bsd
  76. system  I  am using, having all these functions 'extern' does not mean
  77. that they will all be loaded; only the ones you call are.  When  using
  78. lesser  systems you may find it necessary to break strings.h up or you
  79. could get by with just adding "extern" declarations for  functions  as
  80. you  need  them.   Note  that  as  many  of these functions have names
  81. matching "standard C library" names (by design, this is  after  all  a
  82. replacement/reimplementation  of part of that library) you may have to
  83. talk the loader into loading this library first.  Again, I've found no
  84. problems on 4.1bsd.
  85.  
  86.     A note on character comparison.  The various UNIX manuals come out
  87. and say explicitly that the *cmp and *chr routines use the computer's
  88. "native" character comparison.  That is, on a PDP-11, VAX-11, and some
  89. other machines, signed character comparison is used, and the byte 0377
  90. will never be located (use -1).   On IBM 370s and many other machines,
  91. unsigned character comparison is used, and the byte -1 can't be found.
  92. (Use 0377.)  If you have occasion to use 8-bit byte values in calls to
  93. *chr functions, it would be nice if the package looked after making it
  94. work portably.  I thought about that, and decided not to do it, as you
  95. might *want* to write VAX code that didn't find 128, and might rely on
  96. the current effect. However, you should be able to use 8-bit values in
  97. a portable fashion if you ask, and that the package DOES do for you.
  98. There is a macro
  99.        int2char(c)
  100. which takes the bottom 8 bits of c on a machine with unsigned character
  101. comparison or sign-extends them on a machine with signed comparison. It
  102. is up to you to use this macro in appropriate places.  It is up to who-
  103. ever installs the package to make sure that the right definition is put
  104. in and the wrong one commented out.
  105.  
  106.     You may wonder at my failure to provide manual pages for this  code.
  107. For  the things in V7, 4.?, or SIII, you should be able to use whichever
  108. manual page came with that system, and anything I might write  would  be
  109. so  like it as to raise suspicions of violating AT&T copyrights.  In the
  110. sources you will find comments which provide far more documentation  for
  111. these  routines  than AT&T ever provided for their strings stuff, I just
  112. don't happen to have put it in nroff -man form.   Had I done so, the *.3
  113. files would have outbulked the .c files!
  114.  
  115.     There is a manual page for the strx family of routines.   It was the
  116. work of Tony Hansen, of AT&T Information Systems Lincroft NJ.  It is not
  117. clear whether I should distribute this manual page or not,  but as these
  118. functions are not likely to documented anywhere else I decided to risk
  119. it.  There is no risk in the *code* however.  His posting to net.sources
  120. arrived at Edinburgh with just the reason for reposting, and the manual
  121. page.  The code is my own work based on his manual page.  Indeed, I had
  122. already written strx[n]mov, using different names.
  123.  
  124.     These files are in the public domain.  This includes getopt.c, which
  125. is the work of Henry Spencer, University of Toronto Zoology, who says of
  126. it "None of this software is derived from Bell software. I had no access
  127. to the source for Bell's versions at the time I wrote it.  This software
  128. is hereby explicitly placed in the public domain.  It may  be  used  for
  129. any purpose on any machine by anyone." I would greatly prefer it if *my*
  130. material received no military use.
  131.  
  132.